為了提高程式碼的可讀性和可維護性。Java遵循一些命名慣例有助於讓程式碼更容易理解,並讓其他人更容易閱讀和協作。以下是一些Java程式碼命名的重要慣例:
類別名稱(Class Names):
- 以大寫字母開頭,使用大駝峰命名法(UpperCamelCase),即每個單詞的首字母都大寫,且單詞連接的首個英文字母大寫沒有空格或底線_,通常為名詞。
- 例如:
Person
, Car
, StudentRecord
方法名稱(Method Names):
- 小駝峰命名法(lowerCamelCase)跟大駝峰類似但以小寫字母開頭,通常為動詞。
- 例如:
calculateTotal
, getName
, setAge
變數名稱(Variable Names) :
- 小駝峰命名法,通常為名詞。
- 例如:
count
, fullName
, customerList
常數名稱(Constant Names):
- 大蛇形式:全大寫字母,並使用底線分隔單詞,通常為名詞。
- 例如:
MAX_VALUE
, PI
, DEFAULT_TIMEOUT
套件名稱(Package Names):
- 套件名稱應該使用小寫字母,且通常是反域名(倒置的網域名稱)。
- 常包含:
- 例如:
com.example.company
界面名稱(Interface Names):
- 大駝峰命名法,通常是名詞或形容詞
- 例如:
Runnable
, Serializable
枚舉型別名稱(Enum Names):
- 大駝峰命名法
- 例如:
DayOfWeek
, Color
列舉常數(Enum Constants):
- 全大寫,且使用底線分隔單詞。
- 例如:
MONDAY
, RED
參數(引數)名稱(Parameter Names):
- 方法和建構方法的參數名稱都使用小駝峰命名法
- 例如:
calculateArea(double radius)
, setFullName(String fullName)
布林變數名稱(Boolean Variable Names):
- 布林變數名稱應該以is、has、can等前綴詞開頭,然後使用駝峰命名法。
- 例如:
isValid
, hasPermission
, canEdit
注意:
- 命名縮寫 : 盡量避免使用縮寫,除非是廣泛接受的縮寫,並且不會降低可讀性。例如,使用**
length
而不是len
**。
- 意義清晰 : 命名應該具有描述性,讓人能夠清楚地理解該變數、方法或類別的用途和功能。
- 避免保留字 : 不能使用Java的保留字(例如,
class
,int
,for
)直接作為命名,但可以包含其中。
- 一致性 :在整個程式碼中保持一致的命名風格,以提高可維護性。
今天就到這邊,我們明天繼續~